Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🎉 Survey Monkey: Improve 'check' using '/users/me' API call #7868

Merged
merged 7 commits into from
Nov 18, 2021

Conversation

grubberr
Copy link
Contributor

@grubberr grubberr commented Nov 11, 2021

Signed-off-by: Sergey Chvalyuk grubberr@gmail.com

What

In current implementation of "check" command connector reads "Surveys" stream which can be empty.
If stream is empty we got error but in really - connection is OK.

How

In new implementation, we call API endpoint https://api.surveymonkey.com/v3/users/me to make sure we have valid credentials and also as bonus check that we have all needed oAuth scopes.

Recommended reading order

  1. x.java
  2. y.python

Pre-merge Checklist

Expand the relevant checklist and delete the others.

Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the new connector version is published, connector version bumped in the seed directory as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>
@github-actions github-actions bot added the area/connectors Connector related issues label Nov 11, 2021
@grubberr grubberr changed the title stream can be empty for "check" 🎉 Survey Monkey: stream can be empty for "check" Nov 11, 2021
@grubberr grubberr temporarily deployed to more-secrets November 11, 2021 16:03 Inactive
@grubberr grubberr linked an issue Nov 11, 2021 that may be closed by this pull request
@grubberr grubberr self-assigned this Nov 11, 2021
Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>
@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Nov 11, 2021
@grubberr grubberr temporarily deployed to more-secrets November 11, 2021 16:10 Inactive
@grubberr grubberr temporarily deployed to more-secrets November 18, 2021 09:54 Inactive
@grubberr grubberr changed the title 🎉 Survey Monkey: stream can be empty for "check" 🎉 Survey Monkey: Improve 'check' using '/users/me' API call Nov 18, 2021
@grubberr grubberr temporarily deployed to more-secrets November 18, 2021 12:10 Inactive
@grubberr
Copy link
Contributor Author

grubberr commented Nov 18, 2021

/test connector=connectors/source-surveymonkey

🕑 connectors/source-surveymonkey https://github.com/airbytehq/airbyte/actions/runs/1476325905
✅ connectors/source-surveymonkey https://github.com/airbytehq/airbyte/actions/runs/1476325905
Python tests coverage:

	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                                 Stmts   Miss  Cover
	 ------------------------------------------------------------------------
	 source_acceptance_test/__init__.py                       2      0   100%
	 source_acceptance_test/base.py                          10      4    60%
	 source_acceptance_test/config.py                        75      8    89%
	 source_acceptance_test/conftest.py                     108    108     0%
	 source_acceptance_test/plugin.py                        47     47     0%
	 source_acceptance_test/tests/__init__.py                 4      0   100%
	 source_acceptance_test/tests/test_core.py              200     94    53%
	 source_acceptance_test/tests/test_full_refresh.py       38     27    29%
	 source_acceptance_test/tests/test_incremental.py        69     38    45%
	 source_acceptance_test/utils/__init__.py                 6      0   100%
	 source_acceptance_test/utils/asserts.py                 37      2    95%
	 source_acceptance_test/utils/common.py                  41     24    41%
	 source_acceptance_test/utils/compare.py                 62     25    60%
	 source_acceptance_test/utils/connector_runner.py        82     49    40%
	 source_acceptance_test/utils/json_schema_helper.py     115     14    88%
	 ------------------------------------------------------------------------
	 TOTAL                                                  896    440    51%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                              Stmts   Miss  Cover
	 -----------------------------------------------------
	 source_surveymonkey/__init__.py       2      0   100%
	 source_surveymonkey/source.py        35     19    46%
	 source_surveymonkey/streams.py      145     86    41%
	 -----------------------------------------------------
	 TOTAL                               182    105    42%

@jrhizor jrhizor temporarily deployed to more-secrets November 18, 2021 12:12 Inactive
Copy link
Contributor

@antixar antixar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! @grubberr , please merge and publish your fix because your solution is simple and obvious.

@grubberr
Copy link
Contributor Author

grubberr commented Nov 18, 2021

/publish connector=connectors/source-surveymonkey

🕑 connectors/source-surveymonkey https://github.com/airbytehq/airbyte/actions/runs/1476426116
✅ connectors/source-surveymonkey https://github.com/airbytehq/airbyte/actions/runs/1476426116

@jrhizor jrhizor temporarily deployed to more-secrets November 18, 2021 12:40 Inactive
Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>
@grubberr grubberr merged commit b76d155 into master Nov 18, 2021
@grubberr grubberr deleted the grubberr/7817-source-surveymonkey branch November 18, 2021 12:52
@grubberr grubberr temporarily deployed to more-secrets November 18, 2021 12:53 Inactive
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
…q#7868)

* Improve 'check' using '/users/me' API call

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: Error message should be more readable
5 participants